The fcSDK environment requirements can be found in the section titled 'fcSDK Environment Requirements'.
The fcSDK ships as a single ZIP file, containing the installation package for the fcSDK itself as well as a separate compiled help module (CHM) documentation file in which this installation guide exists.
FCFL/COM and the fcSDK can run side-by-side on the same computer. Each can be configured to run against the same or different Clarify™ database instances without issue. The fcSDK requires a few schema modifications in addition to those required by the FCFL/COM installation. Please read the 'Schema Modification' section later in this document for more information on what these extra requirements are.
NOTE: The fcSDK installer requires a user with Administrative privileges on the local machine to execute the installation. Please ensure that you are logged on as a user with such privileges before starting.
Start the installation process of the fcSDK by extracting the contents of the ZIP file to a temporary directory on the machine on which the fcSDK is to be installed. Start the installation by double-clicking on the fcsdk.exe file. The installer wizard will start and will take you through the following steps:
Choose Setup Type - Select from Typical or Developer installations. You may also select Custom to control in detail what features are installed and what location they are installed. By default software is installed to "C:\Program Files\Dovetail Software\fcSDK".
When selecting a Custom setup type you will be presented with a treeview containing the available features of the installer. Here is a brief summary of each feature.
The fcSDK exposes performance counters that can be monitored using the Windows Performance Monitor utility (perfmon). In order for the fcSDK to connect to its performance counters and be able to update their values, certain permissions are required to access a few registry keys.
Normal Windows users have this privilege and no special permissions are required. However, if the fcSDK is to be run from a low-privileged app (such as a Windows Service running as the NETWORK SERVICE user or as an ASP/ASP.NET web application like Dovetail's Agent software, it will require extra permissions for these users on specific keys.
Important: To make the performance counters available the fcSDK installer sets the following registry keys to be read accessible to Everyone.
It is easiest to use the Everyone user when setting these permissions since there is little security threat posed by these registry keys. However, if you do not wish to use the Everyone use and wish to use specific users, please see below for specific information about which user(s) are required.
Which user(s) require the permissions mentioned above depends on the application. If you have a custom applications, the application developers should know which user or users require the permissions. For Dovetail products, see below:
NOTE: It is possible to disable the performance counter functionality in the fcSDK and thus avoid the need for special permissions. For more information, please see the section titled 'Basic fcSDK Configuration'.
The paths mentioned below are relative to the installation path specified when using the installer. By default, this path is C:\Program Files\Dovetail Software\fcSDK. The following directories are created under the installation root:
| Directory Name | Purpose |
|---|---|
| bin | All the binaries and assemblies for the fcSDK product. |
| docs | User and developer documentation |
| files | Support files such as data import files |
| icons | Icons used for the Start Menu shortcuts and applications |
| samples | Sample scripts, configuration files, and other files |
| schema | Schema file(s) for installing required and optional schema changes for the fcSDK |
| sprocs | SQL scripts used for installing stored procedures required by the fcSDK |
The fcSDK requires certain schema modifications and can benefit from certain optional modifications.
In order to modify the schema of your Clarify™ database, you must
have Dovetail SchemaEditor or
the correct database administration tools for your specific Clarify™
version and database platform. Files needed for Schema Modification are
in the schema folder located
in the fcSDK installation
directory
To make the required schema changes using Dovetail SchemaEditor,
perform the following steps:
Required:
The command(s) completed successfully.Alternatively, the "isql" command-line utility can be used to execute the creation of the stored procedures. Ensure that the MSSQL installation "binn" directory is in your system PATH environment variable by typing "isql /?" at the command prompt. You should see the usage help text for the isql command. If you get an error, please add the "binn" (note the extra 'n') folder in your MSSQL installation directory to your PATH environment variable. From a command-line, change directory to the fcSDK installation path and then again to the 'sql' folder.
isql -S <server> -d <dbname> -U <username> -P <password> -i mssql_sprocs.sql
| Token | Description |
|---|---|
| <server> | MSSQL server/host name (i.e. DB1, DBSVR1, etc) |
| <dbname> | Database name on the SQL server instance (i.e. cl12, clarify, etc) |
| <username> | SQL Authentication username (i.e. sa) |
| <password> | SQL Authentication password |
If no errors are returned, the stored procedure was created successfully. The result output should look similar to this:
1> 2> 3> 4> 5> 6> 7> 8> 9> 10> 11> 12> 13> 14> 15> 16> 17> 18> 19> 20> 21> 22> 23> 24> 25> 26> 27> 28> 29> 1> 2> 3> 4> 5> 6> 7> 1> 2> 1> 2> 3> 4> 5> 6> 7> 8> 1> 2> 1> 2> 1>
NOTE: There are two different Oracle stored procedure files: oracle_sprocs_pre9.sql and oracle_sprocs_post9.sql. The "pre9" file is for Oracle databases running Clarify versions earlier than v9 (NOT the Oracle version, just the Clarify version). The "post9" file is for Oracle databases running Clarify versions 9 or above. Please select the correct file for the example below.
From a command-line, change directory to the 'sql' folder.
Execute sqlplus with the following syntax, replacing the <xxxxx>
tokens as appropriate:
sqlplus <user>/<pass>@<sid> @oracle_sprocs_pre9.sql-OR-
sqlplus <user>/<pass>@<sid> @oracle_sprocs_post9.sql
| Token | Description |
|---|---|
| <user> | Username of a user with DBA/admin privileges on this database |
| <pass> | Password for the user |
| <sid> | ORACLE database instance SID |
A series of output statements from SQL*Plus will be displayed to the console listing successful compilations and creations or errors. If there were no errors, the stored procedures were created successfully. The output from a successful installation will look similar to this example:
SQL*Plus: Release 9.2.0.1.0 - Production on Wed Mar 9 17:46:52 2005
Copyright (c) 1982, 2002, Oracle Corporation. All rights reserved.
Connected to:
Oracle9i Enterprise Edition Release 9.2.0.1.0 - Production
With the Partitioning, OLAP and Oracle Data Mining options
JServer Release 9.2.0.1.0 - Production
Procedure created.
No errors.
Procedure created.
No errors.
Grant succeeded.
PL/SQL procedure successfully completed.
Synonym created.
Grant succeeded.
PL/SQL procedure successfully completed.
Synonym created.
Disconnected from Oracle9i Enterprise Edition Release 9.2.0.1.0 - Production
With the Partitioning, OLAP and Oracle Data Mining options
JServer Release 9.2.0.1.0 - Production
It is important to make sure you have the time zone of your Clarify instance set correctly. To verify and correct this setting you simply need to connect to your Clarify database using your favorite database query utility and execute the following query.
select * from table_time_zone where is_default = 1
If the full_name field returns a value of No Time Zone Specified or has a time zone specified that is incorrect you can correct the issue by setting the is_default field of the appropriate row to 1.
update table_time_zone SET is_default = 0
update table_time_zone SET is_default = 1 WHERE name = '{Your Database Server's timezone}'
For information on how to use the FC License Installer to install
your fcSDK
and other licenses, please see the section titled "Overview of the fcSDK
License Installer"
Data Verifier is a utility that can be run against a Clarify database to ensure that there are no inconsistencies or bad data that might prevent the fcSDK from initializing properly.
After installing the fcSDK and applying the necessary schema changes, it is recommended that you run Data Verifier to confirm the installation was successful.
To learn how to run and use the Data Verifier, please see the section titled "Overview of fcSDK Data Verifier".
After installation, the next step to getting started with the fcSDK is to review the SDK documentation in this document. A good place to start is the Introduction Section.
The SDK documentation includes information on getting started programming with the fcSDK, working with the same applications, limitations and known issues, API reference, and specifics on many of the features included with the fcSDK.